DOC-4730 experimental build target that uses local client repos #1059
Conversation
|
Looks good, but in what scenario would you want to reference a local client repo (possibly outdated) instead of the latest github one? |
@paoloredis When you're developing a code example, you use your local clone of the client repo before eventually submitting the PR, as usual. However, it's best if you test the content of the example in-page by doing a docs build (to check for bad formatting, etc). By default, the docs build references the Github versions of the client repos rather than your local clones. You can change the locations in the docs repo config to reference your local clones, but then you have to change them back periodically or avoid adding the changes when you do |
dwdougherty
left a comment
dwdougherty
left a comment
There was a problem hiding this comment.
Very nice QOL improvement! Thanks, @andy-stark-redis. Approved.
|
Cheers, @dwdougherty and @paoloredis ! |
DOC-4730
Summary:
make.pyfile that builds the docs has a--stackoption that specifies where to locate theindex.jsonfile for the client repos. Currently, we don't specify any option, so it uses the default.localserve) that works the same asmake servebut sets the--stackoption ofmake.pytodata/components_local/index.jsoninstead of the defaultdata/components/index.json. Thedata/components_localfolder is just a copy ofdata/componentsto begin with, but you can change the individual client repo files (redis-py.json, etc) to reference your local clones of the repos instead of the ones on Github.data/components_localto.gitignore.The theory, then, is that you can keep the files in
data/components_localpermanently set to your local client repo clones (changing the branch when necessary) and build with them usingmake localserve. You won't commit this folder by mistake because it is in.gitignore.Any suggestions for a better approach, better names, showstoppers, etc, are all very welcome :-)